
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Command Line Actions &#8212; iprPy 0.10.2 documentation</title>
    <link rel="stylesheet" href="../_static/basic.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <script type="text/javascript" src="../_static/language_data.js"></script>
    <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
    <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Extending iprPy" href="../extend/index.html" />
    <link rel="prev" title="High-Throughput Calculation Execution" href="htp.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../extend/index.html" title="Extending iprPy"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="htp.html" title="High-Throughput Calculation Execution"
             accesskey="P">previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">iprPy 0.10.2 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Calculations</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="command-line-actions">
<h1>Command Line Actions<a class="headerlink" href="#command-line-actions" title="Permalink to this headline">¶</a></h1>
<p>Most of the high-throughput actions can alternatively be performed at the
command line using the iprPy file located in the iprPy/bin directory.  The
following examples show the command assuming that the working directory for
your terminal is iprPy/bin.</p>
<div class="section" id="define">
<h2>Define<a class="headerlink" href="#define" title="Permalink to this headline">¶</a></h2>
<p>Save database access information to a simple name</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy set_database &lt;database name&gt;
</pre></div>
</div>
<p>This will prompt for the database style, host and any other necessary access
parameters.</p>
<p>Save run_directory access information to a simple name</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy set_run_directory &lt;run_directory name&gt;
</pre></div>
</div>
<p>This will prompt for the run_directory path.</p>
<p>There are also similar unset_ options that will delete the stored access
information.</p>
</div>
<div class="section" id="build">
<h2>Build<a class="headerlink" href="#build" title="Permalink to this headline">¶</a></h2>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy build_refs &lt;database name&gt;
</pre></div>
</div>
</div>
<div class="section" id="prepare">
<h2>Prepare<a class="headerlink" href="#prepare" title="Permalink to this headline">¶</a></h2>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy prepare &lt;database name&gt; &lt;run_directory name&gt; &lt;calculation name&gt; &lt;input file&gt;
</pre></div>
</div>
</div>
<div class="section" id="runner">
<h2>Runner<a class="headerlink" href="#runner" title="Permalink to this headline">¶</a></h2>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy runner &lt;database name&gt; &lt;run_directory name&gt;
</pre></div>
</div>
</div>
<div class="section" id="other">
<h2>Other<a class="headerlink" href="#other" title="Permalink to this headline">¶</a></h2>
<p>check_modules will list all modular class and function styles that were
successfully and unsuccessfully imported with iprPy.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy check_modules
</pre></div>
</div>
<p>check_records will show how many records of a given style are in the database,
and how many of each are completed, still to run, and issued errors.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy check_records &lt;database name&gt; &lt;record style&gt;
</pre></div>
</div>
<p>copy_records will copy records of a given style from one database to another.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy copy_records &lt;database name&gt; &lt;database name&gt; &lt;record style&gt;
</pre></div>
</div>
<p>clean_records will reset calculations that issued errors by moving them back
into the run_directory and removing any .bid files.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy clean_records &lt;database name&gt; &lt;run_directory name&gt; &lt;record style&gt;
</pre></div>
</div>
<p>destroy_records will permanently delete all records of a given style from the
run_directory.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>./iprPy destroy_records &lt;database name&gt; &lt;record style&gt;
</pre></div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Command Line Actions</a><ul>
<li><a class="reference internal" href="#define">Define</a></li>
<li><a class="reference internal" href="#build">Build</a></li>
<li><a class="reference internal" href="#prepare">Prepare</a></li>
<li><a class="reference internal" href="#runner">Runner</a></li>
<li><a class="reference internal" href="#other">Other</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="htp.html"
                        title="previous chapter">High-Throughput Calculation Execution</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="../extend/index.html"
                        title="next chapter">Extending iprPy</a></p>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="../extend/index.html" title="Extending iprPy"
             >next</a> |</li>
        <li class="right" >
          <a href="htp.html" title="High-Throughput Calculation Execution"
             >previous</a> |</li>
        <li class="nav-item nav-item-0"><a href="../index.html">iprPy 0.10.2 documentation</a> &#187;</li>
          <li class="nav-item nav-item-1"><a href="index.html" >Calculations</a> &#187;</li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
    </div>
  </body>
</html>